home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 February / macformat-047.iso / Shareware Plus / Comms / WWWStat4Mac 1.4.3 / WWWStat4Mac-FAT / WWWStat4Mac-FAT.rsrc / TEXT_128_Default Preferences File.txt < prev    next >
Encoding:
Text File  |  1996-11-10  |  16.5 KB  |  367 lines

  1. # --------------------------------------
  2. # WWWStat4Mac   P.J.Hardman 1995-1996. email redpoint@kagi.com.
  3. #          Preferences file.
  4. # WWWStat4Mac is Shareware ($10). Don't forget to REGISTER your copy.
  5. # This file should be in the preferences folder in the system folder.
  6. # --------------------------------------
  7. # Any line that starts with a # is ignored. The program doesn't expect
  8. # to find the information below in the any order but it does help to keep things tidy. 
  9. # Each option has two parts. The option identifier and the argument. Please make sure 
  10. # that you have both of these parts as I can't guarantee what might happen if one is missing.
  11. #
  12. # Here we go!
  13. #
  14. # If you've been good and sent in you registration fee, then you will have got a message from 
  15. # kagi telling you how to register the program. To make it a bit easier I've even added the
  16. # option for you to fill in below. Just type in the code.
  17. #
  18. registration_code TYPE_CODE_HERE!
  19. #
  20. # First lets start with the basic file generation options.
  21. # What do you want the file to be called? This is just the default name that appears in
  22. # the programs Save Dialog or the filename if you have auto_save turned on.
  23. # Note that the file will be saved in the same directory/folder as the log file.
  24. #
  25. file_name statistics.html
  26. #
  27. # Do you want to automatically save the output file. This option means that a file with
  28. # the name file_name is created. If a file with this name already exists it is overwritten.
  29. # [on/off]. When a file is created automatically, it is saved in the SAME FOLDER as the log
  30. # file that you created it from.
  31. #
  32. auto_save off
  33. #
  34. # Which application would you like to have created the file? 
  35. # For example BBEdit is R*ch. SimpleText is ttxt.
  36. #
  37. file_creator R*ch
  38. #
  39. # Do you want the errors to be excluded?.For example if a file doesn't exist and the request 
  40. # fails then we don't add it to the list of files requested. 
  41. # However the site that tried to access the file will be included. [on/off]
  42. #
  43. exclude_errors on
  44. #
  45. # How many sites and files do you want to keep track of?
  46. # This option is now implemented in version 1.3!
  47. max_sites 2000
  48. max_files 500
  49. #
  50. # # NEW IN VERSION 1.3
  51. # Do you want to create a cache of the information processed?. If you make a cache file then
  52. # the next time the log file is analysed all of the data already in the cache can be used to
  53. # save processing time. Then only the new information in the log has to be added to the
  54. # cache. The only caveat is that if you change your options the cache might become invalid.
  55. #    This is most important if you changed the file or site filters.
  56. # This option is either on or off.
  57. #
  58. create_cache off
  59. #
  60. # The output file will always contain, as a bare minimum, a summary of the server traffic.
  61. # Including the no.hits, no. sites, no. files and total bytes transfered. 
  62. # However the next 4 options can be added as needed. [on/off]
  63. # 1. Site Statistics. (Show the top N sites or all if N=0).
  64. # -------------------
  65. #
  66. site_stats on
  67. #
  68. # 2. File Statistics. (Show the top N files or all if N=0).
  69. # -------------------
  70. #
  71. file_stats on
  72. #
  73. # 3. Robot Statistics. This attempts to list all the net robots,spiders and search
  74. # engines that have accessed your server and requested the file robots.txt
  75. #
  76. robot_stats off
  77. #
  78. # 4. Domain Statistics. This makes a list of hits and bytes transfered to each of the domains.
  79. # The domain list came from the following URL:
  80. # http://www.ics.uci.edu/WebSoft/wwwstat/country-codes.txt.
  81. # If you need to make additions to the file these can be added in the STR# resource ID 129.
  82. #
  83. domain_stats off
  84. #
  85. # NEW IN VERSION 1.3
  86. # How many domain names would you like to cache?
  87. # This option allows you to make a local domain name cache so that you can resolve
  88. # domain names without having to look them up. If you don't want to have a cache set this
  89. # option to zero. A good idea is to process the log without a domain cache and see how many
  90. # unresolved hits there are by looking at the domain stats. Then increase the cache to
  91. # about half of this. There will nearly always be some sites that cannot be resolved.
  92. dns_cache 0
  93. #
  94. # Traffic Statistics.
  95. # Do you want to see when your server is busiest? Which month had the most accesses? Which
  96. # day of the week sees the most hits? Then this is where you set these options.
  97. # If you want to collect statistics for the amount of traffic that you server is getting then
  98. # you can request data covering several time spans. You can look at the data by Hour of Day,
  99. # Day of Week,Day of Year, Week of Year, and by Month of Year. You can choose to have some or
  100. # all of these options on at the same time.
  101. #
  102. # traffic_stats hourly
  103. # traffic_stats daily
  104. # traffic_stats weekly
  105. # traffic_stats monthly
  106. # traffic_stats dayofyear 
  107. #
  108. # NEW IN VERSION 1.2
  109. # How do you want to display your traffic? Do you want to see the number of bytes transfered or
  110. # the number of accesses? You have three options bytes,hits or both.
  111. # traffic_display both
  112. #
  113. # How many sites files and domains do you actually want to show?
  114. # NOTE. If you want show all of the sites/files/domains then make these values 0.
  115. # NOTE. If you have the output as tables (see later) then it is best to limit 
  116. # these values to less than 50. Otherwise browsers will require large amounts of memory to
  117. # display these tables.
  118. #
  119. top_sites 0
  120. top_files 0
  121. # NEW IN VERSION 1.2
  122. top_domains 0
  123. #
  124. # How do you want to sort the SITE data that is collected. You have five options 
  125. # [name/hits/bytes/date/visits].See later for info on how to specify a 'visit'.
  126. # Sort by name sorts alphabetically. By hits, bytes and visits sort in descending order.
  127. # By date sorts in reverse chronological order. So most recent sites come first.
  128. #
  129. sort_sites name
  130. #
  131. # How do you want to sort the file data that is collected. You have five options 
  132. # [name/hits/bytes/date/size].
  133. # Sort by name sorts alphabetically. By hits, bytes and size sort in descending order.
  134. # By date sorts in reverse chronological order. So most recent files come first.
  135. #
  136. sort_files bytes
  137. #
  138. # How do you want to sort the domain data that is collected. You have four options 
  139. # [name/hits/bytes/date].
  140. # Sort by name sorts alphabetically. By hits and bytes sort in descending order.
  141. # By date sorts in reverse chronological order. So most recent domains come first.
  142. #
  143. sort_domains hits
  144. #
  145. #    Now that you have defined what you want in the output file in the way of sites/files/domains
  146. # it is now time to FINE TUNE the analysis of the information.
  147. #
  148. # Inclusions. This option allows you to define in the next section up to 
  149. # 50 sites and 50 files that you would like to explicitly include in the output. You might
  150. # want to do this because you only want to look at a portion of your statistics file.
  151. # You can later exclude any files that are included here, but that you don't want to show
  152. # in the final result. For example gifs.
  153. # NOTE.ANY SITE OR FILE THAT IS NOT INCLUDED WILL BE EXCLUDED. 
  154. #
  155. # First list each SITE that you want to INCLUDE on a separate line.
  156. # Make sure that there is only one space between inclusion and the sitename.
  157. # Don't forget to include the IP address in case the DNR resolver isn't active.
  158. # Wildcards are also supported at either the beginning or end of a string but not 
  159. # in the middle.
  160. #
  161. # site_inclusion your.host.machine.here
  162. # site_inclusion 1.2.3.4
  163. # site_inclusion *.com include all US commercial sites
  164. #
  165. # Now list each FILE that you want to include on a separate line.
  166. # NOTE. Don't forget that you need to supply the full path name for the file as it would 
  167. # appear in the access log. These files are not case sensitive, as we convert all file
  168. # names to lowercase before comparing them.
  169. # Wildcards are also supported at either the beginning OR end of a string but not 
  170. # in the middle.
  171. #
  172. # file_inclusion *.gif  This would include all of the gif images.
  173. #
  174. # 6. Exclusions. This option allows you to define in the next section up to 
  175. # 50 sites and 50 files that you would like EXCLUDING from the output. You might
  176. # want to do this to stop some private files from being display in the statistics file.
  177. # Or to stop accesses from your own machine being added during heavy testing sessions. 
  178. # If a file is excluded then it's data is not addedgrand total and it is not included
  179. # in the total number of accesses.
  180. #
  181. # NOTE: If you want to exclude not only the site but also the files that it is accessing then
  182. # set the site_and_file option to on. Otherwise the site will be excluded but the file that was 
  183. # accessed will still be counted.
  184. #
  185. site_and_file off
  186. #
  187. # NEW IN VERSION 1.2
  188. # NOTE: If you want to exclude a file and also the site that was accessing it then
  189. # set the file_and_site option to on. Otherwise the file will be excluded but the site that was 
  190. # accessed will still be counted.(unless excluded elsewhere)
  191. #
  192. file_and_site off
  193. #
  194. # Now list each SITE that you want to EXCLUDE on a separate line.
  195. # NOTE Make sure that there is only one space between exclusion and the sitename.
  196. # Don't forget to include the IP address in case the DNR resolver isn't active.
  197. # Wildcards are also supported at either the beginning or end of a string but not 
  198. # in the middle.
  199. #
  200. # site_exclusion your.host.machine.here
  201. # site_exclusion 1.2.3.4
  202. # site_exclusion *.com   this would exclude all US commercial sites
  203. #
  204. # Now list each FILE that you want to exclude on a separate line.
  205. # NOTE. Don't forget that you need to supply the full path name for the file as it would 
  206. # appear in the access log. These files are not case sensitive, as we convert all file
  207. # names to lowercase before comparing them.
  208. # Wildcards are also supported at either the beginning or end of a string but not 
  209. # in the middle.
  210. #
  211. # file_exclusion *.gif This would exclude all of the gif images.
  212. file_exclusion /statistics.html
  213. file_exclusion /robots.txt
  214. #
  215. #  NOTE 
  216. # All exclusions/inclusions are decided in the following order.
  217. # 1. First check sites for inclusions. If included then carry on otherwise goto 4.
  218. # 2. If included then check for exclusions. If not excluded then goto 4.
  219. # 3. If site_and_file on then also exclude file.
  220. # 4. Check for file inclusions. If included and not excluded in 3 then process.
  221. # 5. If included check for exclusions. If not excluded then process.
  222. # 6. If file_and site on then also exclude site.
  223. # Process the site and file using current exclusions. 
  224. #
  225. #    Misc Options.
  226. # Default File Mapping.
  227. # When a request is made to the server and there is no file defined then this goes into the log
  228. # as a request for /. But this is the same as requesting the default file so we can make hits 
  229. # on / look like hits on the default file. The default file is specified as the argument to
  230. # this option. This replaces the old option map_default_to_home since not all servers have
  231. # home.html as the default file. If the old option is used this automatically calls the 
  232. # map_default_to_file option with the argument home.html. 
  233. # NEW IN VERSION 1.2 This option is now extended to also include hits on folders for example
  234. # /foo/bar/ appears in the log as /foo/bar/home.html  etc. 
  235. #
  236. map_default_to_file home.html
  237. #
  238. # Custom Domains.
  239. # If you want to add your own custom domains these can be specified by adding the new_domain
  240. # option followed by the partial string that need matching. It is important that the whole
  241. # option is in a single string. So for example :-
  242. #
  243. # new_domain UK_Academic.ac.uk
  244. # new_domain UK_Commercial.co.uk
  245. # new_domain Demon_UK.demon.co.uk
  246. # new_domain Manchester_Univ.man.ac.uk
  247. # new_domain Digital_Computer.dec.com
  248. # new_domain IBM_Computer.ibm.com
  249. # new_domain Apple_Computer.apple.com.
  250. #            |<-  All One String   ->|
  251. #  where .apple.com. is the string that is matched. Any 
  252. # sites ending like this will then be added to the domain called Apple_Computer.
  253. # It is also possible to map machines to aliases too. For example 
  254. # new_domain Peter_Hardman.sodium.ch.man.ac.uk
  255. # maps any hits from the machine sodium.ch.man.ac.uk to Peter_Hardman.
  256. # There is a limit of 40 custom domains, but this should be more than enough :-)
  257. #
  258. # Calculating Visits
  259. # More often than not a site will access the server and retrieve a collection of files. This 
  260. # set of files can be thought of as a single "visit" to the server. To define each "visit" we 
  261. # need to set a time between hits that we would expect to to occur in a single visit. So if you
  262. # are serving large text files that need a while to read then set your visit time to be quite
  263. # high. If on the other hand you are serving small text files or small graphics then you might
  264. # want a small visit time. The time is defined in SECONDS. Default time is 300s (ie 5 mins).
  265. #
  266. visit_time 300
  267. #
  268. # Domain Name Resolving
  269. # Version 1.1 adds the ability to resolve names using the domain name system. This gives you
  270. # the opportunity to resolve names that were not resolved by the web-server either because the 
  271. # DNS was down, too slow, or turned off. You need to do two things to get this working.
  272. # First set the resolve_names on or off. Then set the resolve_time to a value in seconds that
  273. # you wish to wait for the DNS to return. If you set the time to 0 then the application will 
  274. # wait until the DNS returns or fails to find a name. Be warned however that this could take up
  275. # to 120 seconds per item!!!!
  276. #
  277. resolve_names off
  278. resolve_time  10
  279. #
  280. # Following several users experiencing crashes with DNS lookups when Open Transport is 
  281. # installed it has been decided to disable the resolve_time option until a fix can be found.
  282. #
  283. # Active Links.
  284. # Do you want the files that are listed in the output to have active links that can be chosen
  285. # in the web browser? This means that someone can look at the stats file and then jump to the
  286. # most popular pages directly.
  287. # If so then turn this option on. Otherwise the files will not be accessible directly from
  288. # the stats file.
  289. active_links off
  290. # Create Tables?
  291. # If you want your output to consist of Tables rather than a simple text file then leave this
  292. # option off. Otherwise turn it on to get stunning tables :-) Of course you need a browser 
  293. # capable of displaying tables for example Netscape Navigator or Microsoft's Internet Explorer.
  294. #
  295. create_tables off
  296. #
  297. # NEW IN VERSION 1.2
  298. # If you want an audible alert that the processing has finished turn on the following option
  299. # otherwise set it to off.
  300. #
  301. completion_sound on
  302. #
  303. # NEW IN VERSION 1.2
  304. # If you want to truncate the file names for cgi-hits then turn this option on. It will
  305. # stop the name before the ?. This option will filter any such things include image map hits.
  306. # In fact anything with a ? in it :-)
  307. #
  308. filter_cgi_hits on
  309. #
  310. # NEW IN VERSION 1.2
  311. # Do you want to include a custom header or footer automatically to your outputed log file?
  312. # For example you could add your company logo at the top and add a button bar at the bottom
  313. # of the file. To do this make files called 'WWWStat4Mac Prefix' and 'WWWStat4Mac Suffix'
  314. # and put them in the preferences folder.
  315. # Then turn on the following options.
  316. #
  317. prefix_file off
  318. suffix_file off
  319. #
  320. # NEW IN VERSION 1.3
  321. # Site and file aliases. If you have a file that you want to make look like some other file
  322. # or a site that has dynamic names that you want to group together then this is where you do
  323. # it. 
  324. # For example host123.aol.com and host321.aol.com can all be made to look like aol.com 
  325. # by using the site_alias option below.
  326. #
  327. # site_alias *.aol.com aol.com
  328. #
  329. # You can make hits on a file look like hits on another. This option can also be used to group
  330. # files together for example gifs.
  331. #
  332. # file_alias *.gif gif_files
  333. #
  334. #    NEW IN VERSION 1.4
  335. #    include_date_in_table  on
  336. #    include_time_in_table  off
  337. #
  338. # Use these options if you want to display the last access time/date of a file/site
  339. # in the output tables. This is most useful if you are sorting these lists by date and
  340. # want to show the last X files accessed or the last X sites to access the server. This is
  341. # really good when used in conjunction with the auto-processing options and the caching for 
  342. # rapid log processing.
  343. #
  344. #    NEW IN VERSION 1.4.1
  345. #    file_type  *.html HTML_Documents
  346. #    file_type  *.hqx Encoded_Macintosh_Files
  347. #
  348. # Use the file type options when you want to keep track of specific files types. This option 
  349. # lets you track how many unique files of each type are served, and the total number of files
  350. # of that type served. The option consists of two parts. The first is the type that you want
  351. # to match. This can contain wildcards at either end of the type. The second is a string 
  352. # giving a description of the type. If you do not wish to enter a description then you can 
  353. # leave this field blank. 
  354. #
  355. #  If there are any problems with this file or you find something that is not explained 
  356. #  fully then please drop me a line.                                                    
  357. #  Peter Hardman   email redpoint@kagi.com                                              
  358.